Skip to content

Review Software Catalog documentation #2008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 38 commits into from
Apr 22, 2025
Merged

Review Software Catalog documentation #2008

merged 38 commits into from
Apr 22, 2025

Conversation

epessina
Copy link
Contributor

@epessina epessina commented Feb 21, 2025

Description

Review of marketplace and Software Catalog documentation

Pull Request Type

  • Documentation content changes
  • Bugfix / Missing Redirects
  • Docusaurus site code changes

PR Checklist

  • The commit message follows our guidelines included in the CONTRIBUTING.md
  • All tests of Lint, cspell and check-content pass. (How to launch them?)
  • No sensitive content has been committed

@epessina epessina force-pushed the feat/catalog-items-doc branch from 843fc41 to c3374d5 Compare April 18, 2025 13:22
@epessina epessina marked this pull request as ready for review April 22, 2025 09:35
@epessina epessina requested a review from a team as a code owner April 22, 2025 09:35
@epessina epessina merged commit 921b5ba into main Apr 22, 2025
6 checks passed
@epessina epessina deleted the feat/catalog-items-doc branch April 22, 2025 09:35
TheRusCompass added a commit that referenced this pull request Apr 23, 2025
* added: UIDs in cspell

* chore(docs): update installation-chart documentation (#2078)

* chore(docs): update Integration Connector Agent documentation (#2079)

* add docs link (#2080)

* chore(docs): update Integration Connector Agent documentation (#2081)

* fixed rn preview v13.7.1 (#2083)

* fixed rn preview

* Update v13.7.1.md

* chore(deps-dev): bump @swc/core in the swc group across 1 directory (#2019)

Bumps the swc group with 1 update in the / directory: [@swc/core](https://github.com/swc-project/swc).


Updates `@swc/core` from 1.10.12 to 1.11.5
- [Release notes](https://github.com/swc-project/swc/releases)
- [Changelog](https://github.com/swc-project/swc/blob/main/CHANGELOG.md)
- [Commits](swc-project/swc@v1.10.12...v1.11.5)

---
updated-dependencies:
- dependency-name: "@swc/core"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: swc
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump dompurify from 3.1.6 to 3.2.4 (#2073)

Bumps [dompurify](https://github.com/cure53/DOMPurify) from 3.1.6 to 3.2.4.
- [Release notes](https://github.com/cure53/DOMPurify/releases)
- [Commits](cure53/DOMPurify@3.1.6...3.2.4)

---
updated-dependencies:
- dependency-name: dompurify
  dependency-version: 3.2.4
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* started env based management doc

* Add files-service mongo 7 compatbility (#2087)

* feat(catalog): add mongodb native connection details (#2052)

* feat(catalog): add mongodb native connection details

* small adjustments

* fix img

* Update docs/data_catalog/frontend/data_catalog_connections.mdx

* Update docs/data_catalog/frontend/data_catalog_connections.mdx

* small fixes

* feat(catalog): update compatibility matrix

* feat(catalog): update compatibility matrix

* chore: spellcheck

* chore: spellcheck

---------

Co-authored-by: Alberto Tessarotto <78902914+albertotessarotto@users.noreply.github.com>

* chore(docs): update Single View Trigger Generator documentation (#2088)

* chore(docs): update Single View Trigger Generator documentation

* chore(docs): update Single View Trigger Generator documentation

* v14 documentation bump (#2092)

* version 14 doc bump

* version support policy

* rem: unused images

* fix cross-version link

* next management

* next management

* fix: cross-version link issue

* fix: cross-version link issue

* docs: explain environment based management

This commit introduces documentation for the Environment Based Management feature, detailing its purpose, functionality, and migration process. It explains the two types of environments (Virtual and Runtime), configuration snapshots, versioning, and the automatic/manual migration process for existing projects.

* docs: refine environment based management documentation

This commit improves the documentation for Environment Based Management by:

- Clarifying the purpose and benefits of unifying Project Revisions and Project Environments.
- Improving the descriptions of Virtual and Runtime Environments.
- Detailing Configuration Snapshot functionality and versioning.
- Providing a more structured explanation of the automatic and manual migration processes.

* docs: refine migration process explanation in environment based management documentation

This commit refines the explanation of the migration process to Environment Based Management:

- Improves clarity and user guidance for both automatic and manual migration methods.
- Details prerequisites for automatic migration, including the requirement for at least one previous deployment and the inheritance of the most recent deployed revision configuration for runtime environments.
- Explains the options available during manual migration, such as selecting configuration snapshots and choosing which revisions to convert to virtual environments.
- Clarifies the behavior when users postpone migration.

* docs: add documentation for environment configuration promotion

This commit introduces documentation for the environment configuration promotion feature.

The documentation explains that environment configuration promotion is a feature that allows users to easily propagate configuration changes across multiple environments, ensuring that all environments are using the same configuration, regardless of whether they are virtual or runtime environments.

* docs: improve migration prompt explanation in environment based management documentation

This commit refines the explanation of the migration prompt within the Environment Based Management documentation.

- Moves the explanation of the "Skip" button and closing the dialog to the initial introduction of the migration process, improving discoverability.
- Removes the redundant explanation from the manual migration section.

* docs: rename and refine environment based management documentation

This commit renames "Environment Based Management" to "Environment Based Configuration Management" and refines the documentation to improve clarity and detail.

- Renames the feature to "Environment Based Configuration Management" for better accuracy.
- Improves the introductory paragraph to emphasize the unified approach of integrating Project Revisions and Project Environments.
- Adds a detailed explanation of the Environment Configuration Promotion feature, including its key capabilities: promoting configurations between environment types, selecting specific environment variables to transfer, reviewing and merging design configurations using an interactive diff editor, and maintaining granular control over settings.

* docs: refine environment types explanation in environment based management documentation

This commit refines the explanation of environment types within the Environment Based Management documentation to improve clarity and detail.

- Clarifies the roles of Virtual and Runtime Environments in providing a comprehensive project management solution.
- Expands the description of Virtual Environments to emphasize their role in configuration management and experimentation.
- Enhances the explanation of Runtime Environments, highlighting their function in connecting virtual environments to clusters for deployment and execution.

* images

* docs: add quick reference to environment based management documentation

This commit adds a quick reference section to the Environment Based Configuration Management documentation.

The quick reference provides a summary of the key concepts of the feature, including the two environment categories, the ability to version and deploy only Runtime Environments, the default usage of the new approach for newly created Projects, and the use of Environment promotion to move configurations between environments.

* docs: add revisions integration to environment based management quick reference

This commit adds a note about revisions being integrated into environments to the Environment Based Configuration Management quick reference.

* docs: refine key concepts and overview in environment based management documentation

This commit refines the key concepts and overview section within the Environment Based Configuration Management documentation to improve clarity and detail.

- Updates the quick reference section to a key concepts and overview section.
- Expands on the key concepts, including dedicated environment configurations, environment categories, deployment capabilities, automatic utilization for new projects, configuration promotion, version control, environment variable display, and deployment restrictions.

* feat: add environments table image to environment based management documentation

This commit adds an image illustrating the environments table to the Environment Based Configuration Management documentation. The image visually represents the different environment types and their relationships, enhancing the explanation of the feature.

* docs: refine environment based management key concepts and overview

This commit refines the key concepts and overview section within the Environment Based Configuration Management documentation to improve accuracy and clarity.

- Clarifies that each environment "has" its own configuration.
- Removes "for configuration management" from the Virtual Environments description for brevity.
- Specifies that the enhanced environment-based management system is used by new projects using the Enhanced Workflow.
- Changes "restricted to" to "bound to" for describing deployment configurations.

* fix: clarify runtime environment deployment options in documentation

This commit clarifies that only Runtime Environments can be deployed using either the latest configuration or a specific versioned configuration in the Environment Based Configuration Management documentation. This change improves the accuracy and understanding of deployment options within the environment-based configuration system.

* chore(docs): update Files Service documentation (#2099)

* Review Software Catalog documentation (#2008)

* Start new structure

* update doc SC

* added new SC section

* Structure

* update doc sc

* Proxy resources

* structure

* add lifecycle section

* add overview

* fix typo

* update doc sc

* stucture

* added sc ui and miactl

* wip basic concepts

* wip: items schemas

* list item ui

* items types

* items-versioning

* fixed lifecycle

* items-management overview

* fix item

* update images

* fix typo

* visibility

* api page

* added links and imgs

* permissions

* versioning

* versioning

* overview runtime components

* versioning

* wip move marketplace

* marketplace section

* miactl

* remove old software catalog doc

* tutorial

* manifests

* fix check-content

---------

Co-authored-by: Claudia Focchi <claudia.focchi@mia-fintech.io>

* feat: add sidecar to marketplace section (#2104)

* feat: add sidecar to marketplace section

* fix links

* chore(docs): update Payment Gateway Manager documentation (#2091)

* chore(docs): update Payment Gateway Manager documentation

* chore(docs): update Payment Gateway Manager documentation

* chore(docs): update Payment Gateway Manager documentation

* chore(docs): update Payment Gateway Manager documentation

* chore(docs): update Payment Gateway Manager documentation

* chore(docs): update Payment Gateway Manager documentation

* chore(docs): update Payment Gateway Manager documentation

* chore(docs): update Payment Gateway Manager documentation

* Feat/extensions sso (#2063)

* feat(extension-sso): doc draft

* wip

* wip

* Apply suggestions from code review

Co-authored-by: Marco Filippi <108082959+marcofilippi@users.noreply.github.com>
Co-authored-by: Daniele Cinà <icloud.d@gmail.com>

* Update sso.md

* Update sso.md

* added image of extensions SSO

* fixed typo

---------

Co-authored-by: Guido Zoli <guido.zoli@mia-platform.eu>
Co-authored-by: Daniele <danielemarostica@gmail.com>
Co-authored-by: Marco Filippi <108082959+marcofilippi@users.noreply.github.com>
Co-authored-by: Daniele Cinà <icloud.d@gmail.com>

* v14-overview (#2072)

* draft

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* Update mia-platform-v14.mdx

* added software catalog news

* Update mia-platform-v14.mdx

* added some introductory paragraphs

* added flow manager updates

* added images

* Apply suggestions from code review

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* minor updates

* Update docs/release-notes/mia-platform-v14.mdx

Co-authored-by: Dario Esposito <dario.esposito@mia-platform.eu>

* Update docs/release-notes/mia-platform-v14.mdx

Co-authored-by: Massibian <84580717+Massibian@users.noreply.github.com>

* reordering AI topics

* Apply suggestions from code review

Co-authored-by: Massibian <84580717+Massibian@users.noreply.github.com>

* Update mia-platform-v14.mdx

* fix typo

* added MCP server

* update mcp server

Co-authored-by: Davide Bianchi <10374360+davidebianchi@users.noreply.github.com>

* Update mia-platform-v14.mdx

* fixed typo

* add doc link

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* Apply suggestions from code review

* Update docs/release-notes/mia-platform-v14.mdx

* Update docs/release-notes/mia-platform-v14.mdx

* add quality assistant

* Update mia-platform-v14.mdx

* fixed typo

* demo link

* Update mia-platform-v14.mdx

* add AI agent image

* img envs

* added audit logs pic

* add images

* add img

* Update mia-platform-v14.mdx

* added env based docs

---------

Co-authored-by: Marco Filippi <108082959+marcofilippi@users.noreply.github.com>
Co-authored-by: Claudia Focchi <claudia.focchi@mia-fintech.io>
Co-authored-by: Nicola Campagna <117760936+TheRusCompass@users.noreply.github.com>
Co-authored-by: Alberto Tessarotto <78902914+albertotessarotto@users.noreply.github.com>
Co-authored-by: Dario Esposito <dario.esposito@mia-platform.eu>
Co-authored-by: Massibian <84580717+Massibian@users.noreply.github.com>
Co-authored-by: Davide Bianchi <10374360+davidebianchi@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>

* infrastructure projects docs (#2090)

* set up infra projects

* Update infrastructure-projects.md

* Update infrastructure-projects.md

* Update infrastructure-projects.md

* Update infrastructure-projects.md

* split docs

* Update infrastructure-projects.md

* edit: add description in add infrastructure component

* fix

* edit: add Infrastructure project selection image

* fix: links

* fix: file name

* fix: project path

* Update infrastructure-project.md

---------

Co-authored-by: Federico Maggi <federico.maggi@mia-platform.eu>
Co-authored-by: Guido Zoli <guido.zoli@mia-platform.eu>

* feat: update Software Catalog items manifests doc (#2105)

* feat: update Software Catalog items manifests doc

* fix link

* chore: fix typo

* setup rn v14.0.0 (#2094)

* setup rn v14.0.0

* substituted enhanced screenshot

* added info on kubernetes info tutorial

* fixed enhanced reference on v13.1.0

* Update v13.1.0.md

* Update v14.0.0.md

* Update v14.0.0.md

* Update v14.0.0.md

* Update docs/release-notes/v14.0.0.md

* added extensions with composer new feature

* added software catalog uodates

* added marketplace API deprecation

* Update v14.0.0.md

* Update v14.0.0.md

* added preview banner

* added link

* fix links

* add img

* add new content

* add extension

* fix link

* added images for infrastructure projects

* little fixes

* little fixes

* add links

* added probable chart helm version for preview release

* added gitlab ref on infra projects

* Update v14.0.0.mdx

* Update v14.0.0.mdx

* Update v14.0.0.mdx

* Update v14.0.0.mdx

* Update v14.0.0.mdx

---------

Co-authored-by: Alberto Tessarotto <78902914+albertotessarotto@users.noreply.github.com>
Co-authored-by: Claudia Focchi <claudia.focchi@mia-fintech.io>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: daniele.cina <daniele.cina@mia-platform.eu>
Co-authored-by: Bot-targa <github@mia-platform.eu>
Co-authored-by: Alberto Tessarotto <78902914+albertotessarotto@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Nicola Melloni <nicola.melloni@mia-care.io>
Co-authored-by: Francesco Francomano <silversoulKali@gmail.com>
Co-authored-by: Giovanni Fiordeponti <38134891+flower-of-the-bridges@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <federico.maggi@mia-platform.eu>
Co-authored-by: Mattia Fumo <mattia.fumo@mia-platform.eu>
Co-authored-by: jacoposte <100678585+jacoposte@users.noreply.github.com>
Co-authored-by: Edoardo Pessina <edoardopessina.priv@gmail.com>
Co-authored-by: Claudia Focchi <claudia.focchi@mia-fintech.io>
Co-authored-by: guidozoli <64744713+guidozoli@users.noreply.github.com>
Co-authored-by: Guido Zoli <guido.zoli@mia-platform.eu>
Co-authored-by: Daniele <danielemarostica@gmail.com>
Co-authored-by: Daniele Cinà <icloud.d@gmail.com>
Co-authored-by: Nicola Campagna <117760936+TheRusCompass@users.noreply.github.com>
Co-authored-by: Dario Esposito <dario.esposito@mia-platform.eu>
Co-authored-by: Massibian <84580717+Massibian@users.noreply.github.com>
Co-authored-by: Davide Bianchi <10374360+davidebianchi@users.noreply.github.com>
Co-authored-by: theRusCompass <nicola.campagna@mia-platform.eu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants